Small documentation additions.

2005-05-08  Matthias Clasen  <mclasen@redhat.com>

	* gdk/gdkcolor.c (gdk_cairo_set_source_color):
	* gdk/gdkimage.h:
	* gdk/gdkdraw.c:
	* gdk/gdkcolor.h:
	* gdk/gdkcursor.h:
	* gdk/x11/gdkcolor-x11.c: Small documentation additions.

diff --git a/ChangeLog b/ChangeLog
index 6985b61ff5245e6d4f333d370f8ad9f6cac5a17e..80c9d11d0c3f3bad201f4c4eef0e5a0a01417f66 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2005-05-08  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdk/gdkcolor.c (gdk_cairo_set_source_color): 
+       * gdk/gdkimage.h: 
+       * gdk/gdkdraw.c: 
+       * gdk/gdkcolor.h: 
+       * gdk/gdkcursor.h: 
+       * gdk/x11/gdkcolor-x11.c: Small documentation additions.
+
 2005-05-07  Matthias Clasen  <mclasen@redhat.com>
 
        * gtk/gtkscrolledwindow.h: 

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 6985b61ff5245e6d4f333d370f8ad9f6cac5a17e..80c9d11d0c3f3bad201f4c4eef0e5a0a01417f66 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,12 @@
+2005-05-08  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdk/gdkcolor.c (gdk_cairo_set_source_color): 
+       * gdk/gdkimage.h: 
+       * gdk/gdkdraw.c: 
+       * gdk/gdkcolor.h: 
+       * gdk/gdkcursor.h: 
+       * gdk/x11/gdkcolor-x11.c: Small documentation additions.
+
 2005-05-07  Matthias Clasen  <mclasen@redhat.com>
 
        * gtk/gtkscrolledwindow.h: 

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 6985b61ff5245e6d4f333d370f8ad9f6cac5a17e..80c9d11d0c3f3bad201f4c4eef0e5a0a01417f66 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,12 @@
+2005-05-08  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdk/gdkcolor.c (gdk_cairo_set_source_color): 
+       * gdk/gdkimage.h: 
+       * gdk/gdkdraw.c: 
+       * gdk/gdkcolor.h: 
+       * gdk/gdkcursor.h: 
+       * gdk/x11/gdkcolor-x11.c: Small documentation additions.
+
 2005-05-07  Matthias Clasen  <mclasen@redhat.com>
 
        * gtk/gtkscrolledwindow.h: 

diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c
index 8c7b4a38416d67f39cbcf572adefc37c7be54056..27bdf194608039a58a6eeea1fe349b0524fe57b7 100644 (file)
--- a/gdk/gdkcolor.c
+++ b/gdk/gdkcolor.c
@@ -378,6 +378,8 @@ gdk_colormap_get_system (void)
  * 
  * Convenience function to set the specified GdkColor as the
  * source color of the given Cairo context.
+ *
+ * Since: 2.8
  **/
 void
 gdk_cairo_set_source_color (cairo_t  *cr,

diff --git a/gdk/gdkcolor.h b/gdk/gdkcolor.h
index df4e2ffc8ccdab96a5e8665c05b5fca2e59eec2f..bbf7bd83f40834f9490413d76ae02decfb8d0153 100644 (file)
--- a/gdk/gdkcolor.h
+++ b/gdk/gdkcolor.h
@@ -4,9 +4,7 @@
 #include <cairo.h>
 #include <gdk/gdktypes.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
 
 /* The color type.
  *   A color consists of red, green and blue values in the
@@ -39,6 +37,7 @@ typedef struct _GdkColormapClass GdkColormapClass;
 
 struct _GdkColormap
 {
+  /*< private >*/
   GObject parent_instance;
 
   /*< public >*/
@@ -144,8 +143,6 @@ void gdk_colors_free         (GdkColormap   *colormap,
                          gulong         planes);
 #endif /* !GDK_DISABLE_DEPRECATED || GDK_COMPILATION */
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 #endif /* __GDK_COLOR_H__ */

diff --git a/gdk/gdkcursor.h b/gdk/gdkcursor.h
index b3e37da260c662d9642dd2a492ed2352fb9c6fce..c91c3d30d0b432b8d375a63de40f6f26d32334e9 100644 (file)
--- a/gdk/gdkcursor.h
+++ b/gdk/gdkcursor.h
@@ -4,9 +4,7 @@
 #include <gdk/gdktypes.h>
 #include <gdk-pixbuf/gdk-pixbuf.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
 
 #define GDK_TYPE_CURSOR (gdk_cursor_get_type ())
 
@@ -98,6 +96,7 @@ typedef enum
 struct _GdkCursor
 {
   GdkCursorType type;
+  /*< private >*/
   guint ref_count;
 };
 
@@ -129,8 +128,6 @@ void        gdk_cursor_unref             (GdkCursor       *cursor);
 #define gdk_cursor_destroy             gdk_cursor_unref
 #endif /* GDK_DISABLE_DEPRECATED */
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 #endif /* __GDK_CURSOR_H__ */

diff --git a/gdk/gdkdraw.c b/gdk/gdkdraw.c
index 3269668b194430dada12e106ba945c99ab92fb61..f956a5bedd13892a30c8351c463c6b46f49bc5c5 100644 (file)
--- a/gdk/gdkdraw.c
+++ b/gdk/gdkdraw.c
@@ -1222,8 +1222,8 @@ gdk_drawable_real_get_composite_drawable (GdkDrawable *drawable,
  * but no area outside of this region will be affected by drawing
  * primitives.
  * 
- * Return value: a #GdkRegion. This must be freed with gdk_region_destroy()
- *               when you are done.
+ * Returns: a #GdkRegion. This must be freed with gdk_region_destroy()
+ *          when you are done.
  **/
 GdkRegion *
 gdk_drawable_get_clip_region (GdkDrawable *drawable)
@@ -1235,15 +1235,15 @@ gdk_drawable_get_clip_region (GdkDrawable *drawable)
 
 /**
  * gdk_drawable_get_visible_region:
- * @drawable: 
+ * @drawable: a #GdkDrawable
  * 
  * Computes the region of a drawable that is potentially visible.
  * This does not necessarily take into account if the window is
  * obscured by other windows, but no area outside of this region
  * is visible.
  * 
- * Return value: a #GdkRegion. This must be freed with gdk_region_destroy()
- *               when you are done.
+ * Returns: a #GdkRegion. This must be freed with gdk_region_destroy()
+ *          when you are done.
  **/
 GdkRegion *
 gdk_drawable_get_visible_region (GdkDrawable *drawable)

diff --git a/gdk/gdkimage.h b/gdk/gdkimage.h
index 1b52f850194f583ebf8f526cb7621c4f28acfd35..dedfc10ed807c41bbd924b29c597f29b5cef5f02 100644 (file)
--- a/gdk/gdkimage.h
+++ b/gdk/gdkimage.h
@@ -3,9 +3,7 @@
 
 #include <gdk/gdktypes.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
 
 /* Types of images.
  *   Normal: Normal X image type. These are slow as they involve passing
@@ -52,7 +50,8 @@ struct _GdkImage
   gpointer     mem;
 
   GdkColormap  *colormap; /* read only. */
-  
+
+  /*< private >*/
   gpointer windowing_data; /* read only. */
 };
 
@@ -103,8 +102,6 @@ GdkImage* gdk_image_new_bitmap (GdkVisual     *visual,
 #define gdk_image_destroy              gdk_image_unref
 #endif /* GDK_DISABLE_DEPRECATED */
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 #endif /* __GDK_IMAGE_H__ */

diff --git a/gdk/x11/gdkcolor-x11.c b/gdk/x11/gdkcolor-x11.c
index cd264c6de0281d5f19b0f271675daf9a59d65d65..9322e9391b9de3cc9917f4b836c2cca68720e9c8 100644 (file)
--- a/gdk/x11/gdkcolor-x11.c
+++ b/gdk/x11/gdkcolor-x11.c
@@ -569,7 +569,7 @@ gdk_colormap_change (GdkColormap *colormap,
  * For full documentation of the fields, see 
  * the Xlib documentation for <function>XAllocColorCells()</function>.
  * 
- * Return value: 
+ * Return value: %TRUE if the allocation was successful
  **/
 gboolean
 gdk_colors_alloc (GdkColormap   *colormap,